Reorganize sidebar before starting to write solution level docs #91
Conversation
✅ Deploy Preview for edge-misc ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I know there's a preview to browse but here's a screenshot of the sidebar: |
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| ## openSUSE Build Service | ||
|
|
There was a problem hiding this comment.
For now this seems fine in the integrations section, but I wonder if we need a separate development section for this kind of content and other contributor guidelines?
There was a problem hiding this comment.
Yes, let's chat about where to put contributor guides separately
|
Superscripts are not able to be added in the sidebar. I'll add a feature request to docusaurus but it might be on me to implement if it's desired by their community. |
Ah, I was assuming we could just use the markdown syntax - I guess we can just go with Metal3 then for now 👍 |
| @@ -0,0 +1,3 @@ | |||
| --- | |||
| title: SLE Micro | |||
| --- | |||
There was a problem hiding this comment.
We could link https://www.suse.com/products/micro/ or perhaps better https://documentation.suse.com/sle-micro here?
I've also been wondering if we should test with LeapMicro e.g https://github.com/suse-edge/metal3-demo currently uses Leap, so it would be a more logical move to switch that to LeapMicro for upstream/community usage, or we can just document how to get the SLEMicro image instead (which is probably OK but not ideal from a community perspective).
There was a problem hiding this comment.
Let's chat about this once I'm back from PTO. It's an interesting thought but I'd like to make sure that Leap Micro and SLE Micro maintain the same ABI compatibility that SLES and Leap do.
Here's some initial thinking about how to better organize our docs.
FWIW, I'm not sold on the actual section naming but I think this grouping gives faster access to the right data. Also, I would eventually remove the Miscellaneous section. Sorting those docs seemed like a larger task than I had time for this afternoon.
The guiding idea is that someone visiting our docs are likely either looking to solve a problem right then or wanting to know if our platform is the right one to choose.
For the group trying to solve a problem, we have a quickstart for each deployment mechanism (and move all of the demo/lab style quickstarts to a sub) as well as the components being used and other integrations.
For the group doing research, the concepts and best practices would likely be the most interesting.
Once we get more user feedback, I'm sure there will need to be a section of FAQs. (I might add that tomorrow...)
I'm opening as a draft PR to get some feedback on where this structure might break.